<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=9" />
    <meta name="generator" content="Doxygen 1.8.16" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>LEAF: LEAF Struct Reference</title>
    <link href="tabs.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="jquery.js"></script>
    <script type="text/javascript" src="dynsections.js"></script>
    <script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script>
    <!-- <script src="/js/template.js"></script> -->
     <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script> 
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
    <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
    <!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> -->
</head>
<body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()">
    <div>
        <!-- do not remove this div, it is closed by doxygen! -->
        <div id="titlearea">
            <table cellspacing="0" cellpadding="0">
                <tbody>
                    <tr>
                    </tr>
                </tbody>
            </table>
        </div>
        <!-- end header part -->
    </div>
</body>
</html><!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">LEAF Struct Reference<div class="ingroups"><a class="el" href="group__leaf.html">LEAF</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Struct for an instance of <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a>.  
 <a href="struct_l_e_a_f.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="leaf-global_8h_source.html">leaf-global.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:af6a61da668f2188e2850eba261e217c4"><td class="memItemLeft" align="right" valign="top"><a id="af6a61da668f2188e2850eba261e217c4"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#af6a61da668f2188e2850eba261e217c4">sampleRate</a></td></tr>
<tr class="memdesc:af6a61da668f2188e2850eba261e217c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current audio sample rate. Set with <a class="el" href="group__leaf.html#gab84d5b2ad600cc920248996c86b72f9f" title="Set the sample rate of LEAF.">LEAF_setSampleRate()</a>. <br /></td></tr>
<tr class="separator:af6a61da668f2188e2850eba261e217c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4c744f56f561ff4acc66ba4bd3ed201"><td class="memItemLeft" align="right" valign="top"><a id="ae4c744f56f561ff4acc66ba4bd3ed201"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#ae4c744f56f561ff4acc66ba4bd3ed201">invSampleRate</a></td></tr>
<tr class="memdesc:ae4c744f56f561ff4acc66ba4bd3ed201"><td class="mdescLeft">&#160;</td><td class="mdescRight">The inverse of the current sample rate. <br /></td></tr>
<tr class="separator:ae4c744f56f561ff4acc66ba4bd3ed201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aaa73e329d20f35039fa5cdd2e6f648"><td class="memItemLeft" align="right" valign="top"><a id="a4aaa73e329d20f35039fa5cdd2e6f648"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#a4aaa73e329d20f35039fa5cdd2e6f648">blockSize</a></td></tr>
<tr class="memdesc:a4aaa73e329d20f35039fa5cdd2e6f648"><td class="mdescLeft">&#160;</td><td class="mdescRight">The audio block size. <br /></td></tr>
<tr class="separator:a4aaa73e329d20f35039fa5cdd2e6f648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabd759d3fcb8411249ab4813424e6b29"><td class="memItemLeft" align="right" valign="top"><a id="aabd759d3fcb8411249ab4813424e6b29"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#aabd759d3fcb8411249ab4813424e6b29">twoPiTimesInvSampleRate</a></td></tr>
<tr class="memdesc:aabd759d3fcb8411249ab4813424e6b29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Two-pi times the inverse of the current sample rate. <br /></td></tr>
<tr class="separator:aabd759d3fcb8411249ab4813424e6b29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b5a79e58a190779d202a188f82e9e86"><td class="memItemLeft" align="right" valign="top"><a id="a8b5a79e58a190779d202a188f82e9e86"></a>
float(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#a8b5a79e58a190779d202a188f82e9e86">random</a> )(void)</td></tr>
<tr class="memdesc:a8b5a79e58a190779d202a188f82e9e86"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to the <a class="el" href="struct_l_e_a_f.html#a8b5a79e58a190779d202a188f82e9e86" title="A pointer to the random() function provided on initialization.">random()</a> function provided on initialization. <br /></td></tr>
<tr class="separator:a8b5a79e58a190779d202a188f82e9e86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad65a59f4aa73365d2e77aeddfca7a449"><td class="memItemLeft" align="right" valign="top"><a id="ad65a59f4aa73365d2e77aeddfca7a449"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#ad65a59f4aa73365d2e77aeddfca7a449">clearOnAllocation</a></td></tr>
<tr class="memdesc:ad65a59f4aa73365d2e77aeddfca7a449"><td class="mdescLeft">&#160;</td><td class="mdescRight">A flag that determines whether memory allocated from the <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> memory pool will be cleared. <br /></td></tr>
<tr class="separator:ad65a59f4aa73365d2e77aeddfca7a449"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bcf1ce65df673f85688cca6f0883723"><td class="memItemLeft" align="right" valign="top"><a id="a8bcf1ce65df673f85688cca6f0883723"></a>
tMempool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#a8bcf1ce65df673f85688cca6f0883723">mempool</a></td></tr>
<tr class="memdesc:a8bcf1ce65df673f85688cca6f0883723"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> mempool object. <br /></td></tr>
<tr class="separator:a8bcf1ce65df673f85688cca6f0883723"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64f1d0c53909f30b0aac882348cd32f2"><td class="memItemLeft" align="right" valign="top"><a id="a64f1d0c53909f30b0aac882348cd32f2"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#a64f1d0c53909f30b0aac882348cd32f2">header_size</a></td></tr>
<tr class="memdesc:a64f1d0c53909f30b0aac882348cd32f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size in bytes of memory region headers within mempools. <br /></td></tr>
<tr class="separator:a64f1d0c53909f30b0aac882348cd32f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c7ae1db705b3fdea2bec18add896856"><td class="memItemLeft" align="right" valign="top"><a id="a7c7ae1db705b3fdea2bec18add896856"></a>
void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#a7c7ae1db705b3fdea2bec18add896856">errorCallback</a> )(<a class="el" href="struct_l_e_a_f.html">LEAF</a> *const, LEAFErrorType)</td></tr>
<tr class="memdesc:a7c7ae1db705b3fdea2bec18add896856"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to the callback function for <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> errors. Can be set by the user. <br /></td></tr>
<tr class="separator:a7c7ae1db705b3fdea2bec18add896856"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc66be5b816adc061930cf832328a44"><td class="memItemLeft" align="right" valign="top"><a id="afdc66be5b816adc061930cf832328a44"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_l_e_a_f.html#afdc66be5b816adc061930cf832328a44">errorState</a> [LEAFErrorNil]</td></tr>
<tr class="memdesc:afdc66be5b816adc061930cf832328a44"><td class="mdescLeft">&#160;</td><td class="mdescRight">An array of flags that indicate which errors have occurred. <br /></td></tr>
<tr class="separator:afdc66be5b816adc061930cf832328a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Struct for an instance of <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="basic-oscillators_8c-example.html#_a0">basic-oscillators.c</a>.</dd>
</dl>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>LEAF/Inc/<a class="el" href="leaf-global_8h_source.html">leaf-global.h</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>
